<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head>
<meta http-equiv="Content-Type" content="text/xhtml;charset=UTF-8"/>
<meta http-equiv="X-UA-Compatible" content="IE=9"/>
<meta name="generator" content="Doxygen 1.8.5"/>
<title>xilasu: ECIES Client APIs</title>
<link href="tabs.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="jquery.js"></script>
<script type="text/javascript" src="dynsections.js"></script>
<link href="navtree.css" rel="stylesheet" type="text/css"/>
<script type="text/javascript" src="resize.js"></script>
<script type="text/javascript" src="navtree.js"></script>
<script type="text/javascript">
  $(document).ready(initResizable);
  $(window).load(resizeHeight);
</script>
<link href="doxygen.css" rel="stylesheet" type="text/css" />
<link href="HTML_custom.css" rel="stylesheet" type="text/css"/>
</head>
<body>
<div id="top"><!-- do not remove this div, it is closed by doxygen! -->
<div id="titlearea">
<table cellspacing="0" cellpadding="0">
 <tbody>
 <tr style="height: 56px;">
  <td id="projectlogo"><img alt="Logo" src="xlogo_bg.png"/></td>
  <td style="padding-left: 0.5em;">
   <div id="projectname">xilasu
   </div>
   <div id="projectbrief">Vitis Drivers API Documentation</div>
  </td>
 </tr>
 </tbody>
</table>
</div>
<!-- end header part -->
<!-- Generated by Doxygen 1.8.5 -->
  <div id="navrow1" class="tabs">
    <ul class="tablist">
      <li><a href="index.html"><span>Overview</span></a></li>
      <li><a href="annotated.html"><span>Data&#160;Structures</span></a></li>
      <li><a href="globals.html"><span>APIs</span></a></li>
      <li><a href="files.html"><span>File&#160;List</span></a></li>
    </ul>
  </div>
</div><!-- top -->
<div id="side-nav" class="ui-resizable side-nav-resizable">
  <div id="nav-tree">
    <div id="nav-tree-contents">
      <div id="nav-sync" class="sync"></div>
    </div>
  </div>
  <div id="splitbar" style="-moz-user-select:none;"
       class="ui-resizable-handle">
  </div>
</div>
<script type="text/javascript">
$(document).ready(function(){initNavTree('group__xasu__ecies__client__apis.html','');});
</script>
<div id="doc-content">
<div class="header">
  <div class="summary">
<a href="#func-members">Functions</a>  </div>
  <div class="headertitle">
<div class="title">ECIES Client APIs</div>  </div>
</div><!--header-->
<div class="contents">
<table class="memberdecls">
<tr class="heading"><td colspan="2"><h2 class="groupheader"><a name="func-members"></a>
Functions</h2></td></tr>
<tr class="memitem:gafa9ae6edbd3dba6873779ab7bdc055b4"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xasu__ecies__client__apis.html#gafa9ae6edbd3dba6873779ab7bdc055b4">XAsu_EciesEncrypt</a> (<a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *ClientParamsPtr, <a class="el" href="struct_x_asu___ecies_params.html">XAsu_EciesParams</a> *EciesParamsPtr)</td></tr>
<tr class="memdesc:gafa9ae6edbd3dba6873779ab7bdc055b4"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends a command to perform the encryption of the given plaintext message using the ECIES protocol.  <a href="#gafa9ae6edbd3dba6873779ab7bdc055b4">More...</a><br/></td></tr>
<tr class="separator:gafa9ae6edbd3dba6873779ab7bdc055b4"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga689f879d22a42d9da5fe3148cd307883"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xasu__ecies__client__apis.html#ga689f879d22a42d9da5fe3148cd307883">XAsu_EciesDecrypt</a> (<a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *ClientParamsPtr, <a class="el" href="struct_x_asu___ecies_params.html">XAsu_EciesParams</a> *EciesParamsPtr)</td></tr>
<tr class="memdesc:ga689f879d22a42d9da5fe3148cd307883"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends command to ASUFW to perform the decryption of the given ciphertext using the ECIES protocol.  <a href="#ga689f879d22a42d9da5fe3148cd307883">More...</a><br/></td></tr>
<tr class="separator:ga689f879d22a42d9da5fe3148cd307883"><td class="memSeparator" colspan="2">&#160;</td></tr>
<tr class="memitem:ga632493276648e0bc48790642d1c29225"><td class="memItemLeft" align="right" valign="top">s32&#160;</td><td class="memItemRight" valign="bottom"><a class="el" href="group__xasu__ecies__client__apis.html#ga632493276648e0bc48790642d1c29225">XAsu_EciesKat</a> (<a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *ClientParamsPtr)</td></tr>
<tr class="memdesc:ga632493276648e0bc48790642d1c29225"><td class="mdescLeft">&#160;</td><td class="mdescRight">This function sends command to ASUFW to perform ECIES Known Answer Tests (KAT's).  <a href="#ga632493276648e0bc48790642d1c29225">More...</a><br/></td></tr>
<tr class="separator:ga632493276648e0bc48790642d1c29225"><td class="memSeparator" colspan="2">&#160;</td></tr>
</table>
<h2 class="groupheader">Function Documentation</h2>
<a class="anchor" id="ga689f879d22a42d9da5fe3148cd307883"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XAsu_EciesDecrypt </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *&#160;</td>
          <td class="paramname"><em>ClientParamsPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_asu___ecies_params.html">XAsu_EciesParams</a> *&#160;</td>
          <td class="paramname"><em>EciesParamsPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends command to ASUFW to perform the decryption of the given ciphertext using the ECIES protocol. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ClientParamsPtr</td><td>Pointer to the <a class="el" href="struct_x_asu___client_params.html" title="This structure contains client parameters information. ">XAsu_ClientParams</a> structure which holds the client input parameters. </td></tr>
    <tr><td class="paramname">EciesParamsPtr</td><td>Pointer to <a class="el" href="struct_x_asu___ecies_params.html" title="This structure contains ECIES params info. ">XAsu_EciesParams</a> structure which holds the parameters of ECIES decryption input arguments.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS, if IPI request to ASU is sent successfully.</li>
<li>XASU_INVALID_ARGUMENT, if any argument is invalid.</li>
<li>XASU_INVALID_UNIQUE_ID, if received Queue ID is invalid.</li>
<li>XST_FAILURE, if sending IPI request to ASU fails. </li>
</ul>
</dd></dl>
<p>Validate input parameters.</p>
<p>Generate a unique ID and register the callback function.</p>
<p>Create command header.</p>
<p>Update request buffer and send an IPI request to ASU. </p>

<p>References <a class="el" href="struct_x_asu___ecies_params.html#a0bd65aa5b7faf176c9e52e3e2347cc98">XAsu_EciesParams::EccCurveType</a>, <a class="el" href="struct_x_asu___ecies_params.html#a0de4e32a344bfe210b9a8e60c387e152">XAsu_EciesParams::EccKeyLength</a>, <a class="el" href="struct_x_asu___ecies_params.html#ad61d0a4035cef34a092e8b8ee2413d1d">XAsu_EciesParams::ShaType</a>, <a class="el" href="group__xasu__client__info.html#gad0de9c14ad7810516d9f71d5b18c44c1">XAsu_CreateHeader()</a>, <a class="el" href="group__xasu__ecies__common__apis.html#gabea090d5e90377bd531c47b85e8854bc">XAsu_EccValidateCurveInfo()</a>, <a class="el" href="group__xasu__common__defs.html#gab1fb206d626e3a467902cbe755df223e">XASU_ECIES_DECRYPT_SHA2_CMD_ID</a>, <a class="el" href="group__xasu__common__defs.html#ga895523f017183f800fa61a4fdd900992">XASU_ECIES_DECRYPT_SHA3_CMD_ID</a>, <a class="el" href="group__xasu__client__info.html#gga06fc87d81c62e9abb8790b6e5713c55ba21f6a079219ddf14b57959e9a40be8b9">XASU_INVALID_ARGUMENT</a>, <a class="el" href="group__xasu__client__info.html#gga06fc87d81c62e9abb8790b6e5713c55bacf18aeeb8b7146572b4eadc9780ad4cb">XASU_INVALID_UNIQUE_ID</a>, <a class="el" href="group__xasu__common__defs.html#ga5bfb3b8701a56d6eb5c6044d197008f9">XASU_MODULE_ECIES_ID</a>, <a class="el" href="group__xasu__client__info.html#ga6653ca717c2d2ed8399945c294af2f9f">XAsu_RegCallBackNGetUniqueId()</a>, <a class="el" href="group__xasu__common__defs.html#gaa7423cf1e6eb12f6d307fcdfadde635e">XASU_SHA2_TYPE</a>, <a class="el" href="group__xasu__common__defs.html#ga0e29ca164aa8fa3ac30a7b9102b615d9">XASU_UNIQUE_ID_MAX</a>, <a class="el" href="group__xasu__client__info.html#ga202195f871d91b50787438e2782be07f">XAsu_UpdateQueueBufferNSendIpi()</a>, <a class="el" href="group__xasu__client__info.html#gae0f7072bf1eddf7ee11f1e5852570682">XAsu_ValidateClientParameters()</a>, and <a class="el" href="group__xasu__ecies__common__apis.html#ga91448b30f049e4d7596cff8103bb6d60">XAsu_ValidateEciesParameters()</a>.</p>

<p>Referenced by <a class="el" href="group__xasu__ecies__example.html#ga840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="gafa9ae6edbd3dba6873779ab7bdc055b4"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XAsu_EciesEncrypt </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *&#160;</td>
          <td class="paramname"><em>ClientParamsPtr</em>, </td>
        </tr>
        <tr>
          <td class="paramkey"></td>
          <td></td>
          <td class="paramtype"><a class="el" href="struct_x_asu___ecies_params.html">XAsu_EciesParams</a> *&#160;</td>
          <td class="paramname"><em>EciesParamsPtr</em>&#160;</td>
        </tr>
        <tr>
          <td></td>
          <td>)</td>
          <td></td><td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends a command to perform the encryption of the given plaintext message using the ECIES protocol. </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ClientParamsPtr</td><td>Pointer to the <a class="el" href="struct_x_asu___client_params.html" title="This structure contains client parameters information. ">XAsu_ClientParams</a> structure which holds the client input parameters. </td></tr>
    <tr><td class="paramname">EciesParamsPtr</td><td>Pointer to <a class="el" href="struct_x_asu___ecies_params.html" title="This structure contains ECIES params info. ">XAsu_EciesParams</a> structure which holds the parameters of ECIES encryption input arguments.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS, if IPI request to ASU is sent successfully.</li>
<li>XASU_INVALID_ARGUMENT, if any argument is invalid.</li>
<li>XASU_INVALID_UNIQUE_ID, if received Queue ID is invalid.</li>
<li>XST_FAILURE, if sending IPI request to ASU fails. </li>
</ul>
</dd></dl>
<p>Validate input parameters.</p>
<p>Generate a unique ID and register the callback function.</p>
<p>Create command header.</p>
<p>Update request buffer and send an IPI request to ASU. </p>

<p>References <a class="el" href="struct_x_asu___ecies_params.html#ad61d0a4035cef34a092e8b8ee2413d1d">XAsu_EciesParams::ShaType</a>, <a class="el" href="group__xasu__client__info.html#gad0de9c14ad7810516d9f71d5b18c44c1">XAsu_CreateHeader()</a>, <a class="el" href="group__xasu__common__defs.html#ga1bdc4ba96d28d4f26a449f37519d070b">XASU_ECIES_ENCRYPT_SHA2_CMD_ID</a>, <a class="el" href="group__xasu__common__defs.html#ga49d89cd6769856715391f2fd599f9de5">XASU_ECIES_ENCRYPT_SHA3_CMD_ID</a>, <a class="el" href="group__xasu__client__info.html#gga06fc87d81c62e9abb8790b6e5713c55ba21f6a079219ddf14b57959e9a40be8b9">XASU_INVALID_ARGUMENT</a>, <a class="el" href="group__xasu__client__info.html#gga06fc87d81c62e9abb8790b6e5713c55bacf18aeeb8b7146572b4eadc9780ad4cb">XASU_INVALID_UNIQUE_ID</a>, <a class="el" href="group__xasu__common__defs.html#ga5bfb3b8701a56d6eb5c6044d197008f9">XASU_MODULE_ECIES_ID</a>, <a class="el" href="group__xasu__client__info.html#ga6653ca717c2d2ed8399945c294af2f9f">XAsu_RegCallBackNGetUniqueId()</a>, <a class="el" href="group__xasu__common__defs.html#gaa7423cf1e6eb12f6d307fcdfadde635e">XASU_SHA2_TYPE</a>, <a class="el" href="group__xasu__common__defs.html#ga0e29ca164aa8fa3ac30a7b9102b615d9">XASU_UNIQUE_ID_MAX</a>, <a class="el" href="group__xasu__client__info.html#ga202195f871d91b50787438e2782be07f">XAsu_UpdateQueueBufferNSendIpi()</a>, <a class="el" href="group__xasu__client__info.html#gae0f7072bf1eddf7ee11f1e5852570682">XAsu_ValidateClientParameters()</a>, and <a class="el" href="group__xasu__ecies__common__apis.html#ga91448b30f049e4d7596cff8103bb6d60">XAsu_ValidateEciesParameters()</a>.</p>

<p>Referenced by <a class="el" href="group__xasu__ecies__example.html#ga840291bc02cba5474a4cb46a9b9566fe">main()</a>.</p>

</div>
</div>
<a class="anchor" id="ga632493276648e0bc48790642d1c29225"></a>
<div class="memitem">
<div class="memproto">
      <table class="memname">
        <tr>
          <td class="memname">s32 XAsu_EciesKat </td>
          <td>(</td>
          <td class="paramtype"><a class="el" href="struct_x_asu___client_params.html">XAsu_ClientParams</a> *&#160;</td>
          <td class="paramname"><em>ClientParamsPtr</em></td><td>)</td>
          <td></td>
        </tr>
      </table>
</div><div class="memdoc">

<p>This function sends command to ASUFW to perform ECIES Known Answer Tests (KAT's). </p>
<dl class="params"><dt>Parameters</dt><dd>
  <table class="params">
    <tr><td class="paramname">ClientParamsPtr</td><td>Pointer to the <a class="el" href="struct_x_asu___client_params.html" title="This structure contains client parameters information. ">XAsu_ClientParams</a> structure which holds the client input parameters.</td></tr>
  </table>
  </dd>
</dl>
<dl class="section return"><dt>Returns</dt><dd><ul>
<li>XST_SUCCESS, if IPI request to ASU is sent successfully.</li>
<li>XASU_INVALID_ARGUMENT, if any argument is invalid.</li>
<li>XASU_INVALID_UNIQUE_ID, if received Queue ID is invalid.</li>
<li>XST_FAILURE, if sending IPI request to ASU fails. </li>
</ul>
</dd></dl>
<p>Validate input parameters.</p>
<p>Generate a unique ID and register the callback function.</p>
<p>Create command header.</p>
<p>Update request buffer and send an IPI request to ASU. </p>

<p>References <a class="el" href="group__xasu__client__info.html#gad0de9c14ad7810516d9f71d5b18c44c1">XAsu_CreateHeader()</a>, <a class="el" href="group__xasu__common__defs.html#gac64cf219e8082c245747001d4fb3ecea">XASU_ECIES_KAT_CMD_ID</a>, <a class="el" href="group__xasu__client__info.html#gga06fc87d81c62e9abb8790b6e5713c55bacf18aeeb8b7146572b4eadc9780ad4cb">XASU_INVALID_UNIQUE_ID</a>, <a class="el" href="group__xasu__common__defs.html#ga5bfb3b8701a56d6eb5c6044d197008f9">XASU_MODULE_ECIES_ID</a>, <a class="el" href="group__xasu__client__info.html#ga6653ca717c2d2ed8399945c294af2f9f">XAsu_RegCallBackNGetUniqueId()</a>, <a class="el" href="group__xasu__common__defs.html#ga0e29ca164aa8fa3ac30a7b9102b615d9">XASU_UNIQUE_ID_MAX</a>, <a class="el" href="group__xasu__client__info.html#ga202195f871d91b50787438e2782be07f">XAsu_UpdateQueueBufferNSendIpi()</a>, and <a class="el" href="group__xasu__client__info.html#gae0f7072bf1eddf7ee11f1e5852570682">XAsu_ValidateClientParameters()</a>.</p>

</div>
</div>
</div><!-- contents -->
</div><!-- doc-content -->
<div id="nav-path" class="navpath"><!-- id is needed for treeview function! -->
	<p class="footer">&copy; Copyright 2015-2022 Xilinx, Inc. All Rights Reserved.</p>
	<p class="footer">&copy; Copyright 2022-2023 Advanced Micro Devices, Inc. All Rights Reserved.</p>
</div>
</body>
</html>
